package com.sgs.carbon.common.exception.enums;

import com.sgs.carbon.common.exception.ErrorCode;

/**
 * 全局错误码枚举
 * 0-999 系统异常编码保留
 *
 * 一般情况下, 使用 HTTP 响应状态码<url>https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Status}</url>
 * 虽然说, HTTP响应状态码作为业务使用表达能力偏弱, 但是使用在系统层面还是非常不错的
 * 比较特殊的是, 因为之前一直使用0作为成功, 就不使用200了
 *
 * @author Dave Liu
 * @date 2021-09-29
 */
public interface GlobalErrorCodeConstants {

    ErrorCode SUCCESS = new ErrorCode(0, "成功");

    // ========== 客户端错误段 ==========
    ErrorCode BAD_REQUEST = new ErrorCode(400, "请求参数不正确");
    ErrorCode UNAUTHORIZED = new ErrorCode(401, "账号未登录");
    ErrorCode FORBIDDEN = new ErrorCode(403, "没有该操作权限");
    ErrorCode NOT_FOUND = new ErrorCode(404, "请求未找到");
    ErrorCode METHOD_NOT_ALLOWED = new ErrorCode(405, "请求方法不正确");
    ErrorCode LOCKED = new ErrorCode(423, "请求失败，请稍后重试");
    ErrorCode TOO_MANY_REQUESTS = new ErrorCode(429, "请求过于频繁，请稍后重试");

    // ========== 服务端错误段 ==========
    ErrorCode INTERNAL_SERVER_ERROR = new ErrorCode(500, "系统异常");

    // ========== 自定义错误段 ==========
    ErrorCode REPEATED_REQUESTS = new ErrorCode(900, "重复请求，请稍后重试");
    ErrorCode DEMO_DENY = new ErrorCode(901, "演示模式，禁止写操作");

    ErrorCode UNKNOWN = new ErrorCode(999, "未知错误");

    /**
     * ErrorCode是否匹配
     * @param code ErrorCode
     * @return 匹配结果
     */
    static boolean isMatch(Integer code) {
        return code != null && code >= SUCCESS.getCode() && code <= UNKNOWN.getCode();
    }

}
